SERVICE

Yes

The name of the service in Site.Service format.

SITE.GNS

SVC_PORT

Yes

The UDP port number for this service. Each service on the computer must have a unique port number. Use the Config File Manager to ensure that all ports for all services on a given server are unique.

6009

REDUNDANT

No

Indicates whether Redundancy is enabled for this service and it is part of a redundant set with other services.

• Set to TRUE to enable Redundancy for this service and indicate that it is in a redundant relationship with another service within the redundancy environment.
• Set to FALSE or commented out to disable Redundancy for this service.

See Redundancy for more configuration details. A redundancy definition for your CygNet environment is configured in the CygNet Redundancy Editor.

The IN_REDUNDANT_SET (Service in redundant set) info item will report whether this service is part of a redundant relationship.

FALSE

ACS

Yes

The Site and Service name of the service’s ACS, in Site.Service format.

SITE.ACS

AUD

No

The Site and Service name of the service’s AUD, in Site.Service format.

SITE.AUD

TRS

Yes

The Site and Service name of the service’s TRS, in Site.Service format.

SITE.TRS

ELS

Yes

The Site and Service name of the service’s ELS, in Site.Service format.

SITE.ELSALM

MSS

Yes

The Site and Service name of the MSS service from which commands will be accepted, in Site.Service format.

SITE.MSS

LOGMASK_ELS

Yes

Specifies the types of service events to be logged to the associated ELS (specified in the ELS keyword). To disable logging to the ELS, comment out the ELS keyword for the selected service. See the Note below this table for more information about the keyword values.

See LOGMASK_ELS in the Logging section of this Help for more information.

The LOGMASK_ELS ( LMask ELS) info item will report the value of this keyword.

CONTROL EXCEPTIONS

LOGMASK_FILE

Yes

Specifies the type(s) of service events to be logged to the service’s log file ([file name].log). During the current session of the service, data is written to the current log file. Log file names follow the naming convention of the selected logging mode (as set by the LOGFILE_MODE keyword value). See the Note below this table for more information about the keyword values.

See LOGMASK_FILE in the Logging section of this Help for more information.

The LOGMASK_FILE (LMask File) info item will report the value of this keyword.

CONTROL EXCEPTIONS WARNING

LOGFILE_FILE_COUNT

Yes

Specifies the maximum number of log files that a service will create before it starts re-using log files. For example, a count of two will produce SVC001.log, then SVC002.log, and then start back at SVC001.log, where SVC is the name of the service. Specify any value from 2 to 100.

See LOGFILE_FILE_COUNT in the Logging section of this Help for more information.

The LOGFILE_FILE_COUNT (File Cnt) info item will report the value of this keyword.

2

LOGFILE_FILE_SIZE

Yes

When the value of the LOGFILE_LIMIT_MODE keyword is set to SIZE, this keyword specifies the maximum size (in megabytes) allowed for a log file, before logging will be continued using the next log file. Possible maximum size values are user-determined, respecting the limits of your specific system configuration. The default value is 100 megabytes. When the specified limit is reached, the log finishes the current line, closes the current file, and then continues logging in the next available log file.

See LOGFILE_FILE_SIZE in the Logging section of this Help for more information.

The LOGFILE_FILE_SIZE (File Size) info item will report the value of this keyword.

100 megabytes

LOGFILE_LINE_COUNT

Yes

When the value of the LOGFILE_LIMIT_MODE keyword is LINE, this keyword specifies the maximum number of lines per log file. When the specified line count is reached, the log file is truncated at the limit point, and logging is resumed using the next available log file. Specify any value from 1000 to 1000000.

See LOGFILE_LINE_COUNT in the Logging section of this Help for more information.

The LOGFILE_LINE_COUNT (Line Cnt) info item will report the value of this keyword.

1000000

LOGFILE_LIMIT_MODE

Yes

Specifies how to limit the size of each individual log file. Options are LINE (maximum line count is determined by the LOGFILE_LINE_COUNT keyword) or SIZE (maximum file size in megabytes) determined by the LOGFILE_FILE_SIZE keyword).

The default value is LINE.

See LOGFILE_LIMIT_MODE in the Logging section of this Help for more information.

The LOGFILE_LIMIT_MODE (Limit Mode) info item will report the value of this keyword.

LINE

LOGFILE_MODE

Yes

Specifies the operational mode for the log file, that is, how log files are maintained. Options are LEGACY or EXTENDED. The default value is LEGACY.

See LOGFILE_MODE in the Logging section of this Help for more information.

The LOGFILE_MODE (Logging Mode) info item will report the value of this keyword.

LEGACY

ACS_ID

Yes

The User ID of the service. This keyword is required for performing security events.

GNS

ACS_APPLICATION

Yes

The service’s application name for security.

GNS

DBS_MAIN_SEC_EVENT

Yes

The main security event for this application. The value must be all uppercase, with a maximum of 8 characters.

ACCESS

DBS_SEC_EVENT_1

No

Secondary security event. It is used by the "navigate" event in the GRP service.

None

DBS_SEC_EVENT_2

No

Additional security event. It is used by the "navigate" event in the GRP service.

None

DBS_SEC_EVENT_3

No

Additional security event. It is used by the "navigate" event in the GRP service.

None

DBS_SEC_EVENT_4

No

Additional security event. It is used by the "navigate" event in the GRP service.

None

DBS_SEC_EVENT_5

No

Additional security event. It is used by the "navigate" event in the GRP service.

None

CHANGE_QUEUE_SIZE

No

Sets the size of the service change queue that contains the incremental changes to the data in the source service. This is the number of changes the service will store to answer replication requests before expiring the oldest changes.

The CHANGE_QUEUE_SIZE (Change Update Queue Size) info item will report configured size of the service change queue.

50000

REPL_SOURCE

No

Specifies the Domain and Site.Service name for the source service to be replicated. If not specified, replication is disabled. Applies to all services except ARS, FMS, and RSM.

The REPL_SOURCE (Repl Source Service) info item will report the source service name from which the replicated service is requesting changes.

Use the Config File Manager to automatically configure this keyword for all services in your CygNet environment.

None

REPL_CHECK_INTERVAL

No

Indicates the interval (in seconds) to check before performing the next replication synchronization. This value determines the replication synchronization frequency.

After performing a sync, a replicating service will subtract the amount of time the sync took from the check interval time to determine how long to wait until the next sync. For example, if the check interval is 60 seconds and the sync takes 40 seconds, the service will only wait 20 seconds before starting the next sync. If the whole sync time exceeds the frequency, then the replicating service will wait for half the sync interval (30 seconds in this case) before starting the next sync.

The REPL_CHECK_INTERVAL (Repl Poll Secs) info item will report the interval that a replicated service will check the source change queue for new updates. If the service is not replicating REPL_CHECK_INTERVAL will respond with an empty string.

0

REPL_DELAY_MAX

No

Indicates the number of seconds a service is allowed to be behind in replication before it is considered to be behind. If this keyword is disabled, the value defaults to double the REPL_CHECK_INTERVAL time. Best practice recommends enabling and setting a meaningful value for REPL_DELAY_MAX for all replicating services. A recommended value would be a longer time interval than you would expect any sync interval to take.

The REPL_DELAY_MAX (Allowed repl delay) info item will report the time elapsed since the service was last fully in sync. Time is calculated as the delta between "now" and the end of the last full sync that has completed. If the time since the last successful sync exceeds the REPL_DELAY_MAX value, and the REPL_INT_VAL_STATE (Int repl val state) info item is currently "Normal", then the REPL_INT_VAL_STATE info item is set to "Delayed." The state can only be set back to "Normal" when the time between two syncs is less than the REPL_DELAY_MAX time.

120

REPL_RETRY_SECS

No

Specifies the interval (in seconds) for retrying a replication update that failed.

5

REPL_ERR_QUEUE_MAX

No

Specifies how many error entries are allowed in temporary storage. When this number is exceeded, replication processing will only process the error queue, nothing else. No new notifications will be accepted, and if a resynchronization is in progress, it will be suspended.

100

AUDIT_LEVEL

No

Sets auditing level of messages written to the AUD service. When set to 0, auditing is off.

1

BACKUP_PATH

No

Specifies the path to the backup directory for the service files. The path can be relative or absolute. If the path contains spaces it must be enclosed in quotation marks. The service will create the backup folder if it does not exist. Use the Config File Manager to automatically configure this keyword for all services in your CygNet environment.

None

BACKUP_TIME

No

Specifies the time for the daily backup to run (24-hour format 0000 to 2359, do not use a colon). If this keyword is not enabled for a service or no time is specified, the automatic backup will not occur. Service backup will only occur if manually initiated or scheduled via the MSS. Use the Config File Manager to automatically configure this keyword for all services in your CygNet environment.

None

COPY_BACKUP_TO

No

Enables copying of the backup service files to the specified directory once the backup process is complete. The path can be relative or absolute. If the directory does not exist the service will create it. If the path or directory name contains spaces, the parameter must be enclosed in quotation marks. If you specify a network drive and are running the CygNet services as system services, you must use the Universal Naming Convention (UNC) (\\Workstation\Path) to specify the path. The backup file can be copied to a network drive only if the drive is mapped to the local machine. Use the Config File Manager to automatically configure this keyword for all services in your CygNet environment.

None

DBS_DATADICT_FILE

No

The name of the Data Dictionary Language (.ddl) file. This keyword is required if the service name is different from the .ddl file name prefix.

GNS.DDL

DBS_DATABASE_FILE

No

The file name of the primary database, including the extension .dat. The service will add the extension .edb.

ServName.dat

DBS_INDEX_FILE

No

The file name of the primary database index, including the extension of .inx. The service will add the extension .edb.

ServName.inx

DBS_TEMPSTOR_FILE

No

The file name for temporary storage, including the extension .ts. The temporary storage file contains uncommitted edits. The service will add the extension .edb.

ServName.ts

ENCRYPTION_KEY_FILE

No

Specifies the name and location of the common encryption key file that stores an AES key used to encrypt and decrypt several usernames and passwords used by CygNet Software. The default file location is the root of the Services directory. See Encrypted Keywords for more information. The file should only be read by the user running the related services and any user that needs to run the Config File Manager, which can be used to change (re-encrypt) any related keyword(s). The Config File Manager can be used to create a new encryption key file, if one did not previously exist.

"..\ServiceConfigEncryptionKey"

DBS_LOCK_TIMEOUT

No

Sets how long (in seconds) the time locks are valid.

1800 (30 minutes)

MAX_CONCURRENT_MSGS

No

Sets the maximum number of concurrent messages allowed between the client and server

To determine the value to set for this keyword, you can assess real-time active message counts by viewing the Act Msgs value (SRVNET_ACT_MSGS (Act Msgs) info item, displayed on the Network and Service Generic pages of the CygNet Service Information dialog box), and trend the count values over time using the SVMAMSG point (SVCMON UDC, analog input type). See Trending Point Data for more information.

20

DBS_DISK_CACHE_IN_MEGS

No

Specifies the maximum amount of memory that the system will allocate for the disk cache in megabytes. See Buffer Cache Management for more information.

The DBS_FILE_CACHE_MAX (DBS file cache max) info item will report the value of this keyword.

50

DBS_MIN_DISK_CACHE_IN_MEGS

No

Specifies the minimum amount of memory that the system will allocate for the disk cache in megabytes. Controls how eager the DBS’s data cache will be to consume memory in the absence of other memory pressure in the system.

1

DBS_FILESYSTEM_CACHE_USAGE

No

Allows a DBS service to configure its database engine with a small dedicated cache and allows Windows to donate spare memory to further improve the caching of database data. See Buffer Cache Management for more information about Windows File System Cache usage.

• Set to ON to enable the usage of the Windows File System Cache.
• Set to OFF to disable the feature entirely.
• Set to HEURISTIC to follow the 10% model used by the DBS_DISK_CACHE_IN_MEGS keyword, described here.

HEURISTIC

DBS_TRANSACTION_LOG_SIZE

Yes

The size (in megabytes) of each log file in the txlogs directory. CygNet recommends using the DbsTxLogManagement utility to change the keyword. Run a backup soon after changing the size value.

5

DBS_TRANSACTION_LOG_DIR

No

Sets the directory where the transaction log files are stored. You cannot specify the main service directory, but it can be a subdirectory or another location. You can specify a different (faster or smaller) drive, or another location if the txlogs directory is being used for something else.

The DBS_TRANSACTION_LDIR (TxLogs Folder) info item can be used to retrieve the fully qualified path.

Use the Config File Manager to automatically configure this keyword for all services in your CygNet environment.

txlogs

MODEM_PORTS

No

The modem port setup information for numeric and alphanumeric paging. Up to 10 COM ports can be configured. Space delimited (COM1 COM2 COM3).

None

MODEM_INIT

No

The modem initialization string for numeric and alphanumeric paging. If a modem does not support carrier detect, include the modem initialization string. Refer to the modem manufacturer’s documentation for more information about initialization strings.

None

ALPHANUMERIC_PHONE

No

The number of the alphanumeric paging company’s modem. Used as default alphanumeric pages. This number can be overridden in the GNS editor. The number can include digits for outside line access and commas for pauses, for example 9, 9, 1-800-555-1212.

None

ALPHANUMERIC_CONNECT_TIMEOUT

No

The time to wait for a connection to complete. Used with older modems that do not support Carrier Detect.

None

SMTP_HOST

No

The SMTP server host name or IP address.

None

SMTP_PORT

No

The port number used by the SMTP server. Usually port 25.

25

SMTP_RECEIVE_TIMEOUT

No

Specifies the maximum amount of time (in seconds) the GNS service will wait for a response from the SMTP server.

30

SMTP_TLS_METHOD

No

The encryption method used for outgoing email notifications. Options include: NONE, SSL/TLS, or STARTTLS. While the General Notification Service (GNS) supports SMTP encryption, it cannot be configured or tested with the GNS Configuration Tester utility (GnsConfig.exe).

NONE

POP3_HOST

No

The POP3 server host name or IP address.

None

POP3_PORT

No

The port number used by the POP3 server. POP3 usually listens on the well-known port 110. Optional.

110

POP3_TLS_METHOD

No

The encryption method used for the incoming POP3 server. Options include: NONE, SSL/TLS, or STARTTLS.

NONE

POP3_UPDATE_RATE

No

The refresh rate for retrieving email from the POP3 server.

10

POP3_RECEIVE_TIMEOUT

No

Sets the maximum amount of time (in seconds) the GNS service will wait for a response from the POP3 server.

30

POP3_EMAIL_RETAIN_COUNT

No

Describes the maximum number of received emails to save to a subdirectory named "mailcache". The value should be less than 4000.

10

PIN_LOCKOUT_MAX_ATTEMPTS

No

Specifies the maximum number of invalid email address and PIN combination attempts before a user is locked out. Set to zero (0) to disable a lockout. Maximum number is 999.

5

PIN_LOCKOUT_DURATION

No

Specifies the time in minutes that an email address and PIN combination will be locked out before automatic unlocking occurs. Set to zero (0) to lock out a user until that user is explicitly unlocked in the GNS PIN Manager in CygNet Explorer. Maximum value is 99,999.

30

PIN_WORK_FACTOR

No

The work factor for PIN hashing. Specify a number between 10 and 31; the default value is 12.

12

EMAIL_ADDRESS

No

The return (from) address for acknowledgment reply emails, such as name@company.com. The return address for all SMTP mail messages.

None

EMAIL_USERNAME

No

The username for the email server, if required. This value is shared by both the POP3 and SMTP email servers. It is required for the Incoming POP3 Server (for receiving acknowledgment reply emails) and optional for the outgoing SMTP Server (for sending SMTP mail messages). The username is encrypted with the common encryption key file.

None

EMAIL_PASSWORD

No

The user password for the email server, if required. This value is shared by both the POP3 and SMTP email servers. It is required for the Incoming POP3 Server (for receiving acknowledgment reply emails) and optional for the outgoing SMTP Server (for sending SMTP mail messages). The password is encrypted with the common encryption key file. The password for the email server cannot be decrypted, as it is only ever compared against.

None

SANDBOX_EMAIL_HANDLING

No

Allows a user to opt out of sandboxing for the SMTP email handler.

yes

VOICE_PROTOCOL

No

The protocol used for voice messaging

DIALOGIC

RESPONSE_PHONE_NUMBER

No

Specifies the dial-in telephone number for notification acknowledgment.

None

VOICE_SPEECH_NAME

No

Specifies the text-to-speech synthesizer to use for voice notifications. The name must be enclosed in quotation marks if it contains spaces (for example, "Microsoft David", "Microsoft Zira"). Voices are shipped with each Windows operating system, or other voices are available for download for use with client, server and mobile platforms from Microsoft and third-party vendors.

Name of voice to use with this keyword.

VOICE_SPEECH_RATE

No

Specifies the speech rate used for voice notifications

0

VOICE_SPEECH_VOLUME

No

Specifies the volume used for voice notifications

80

VOICE_SPEECH_PITCH

No

Specifies the pitch used for voice notifications

0

VOICE_PORTS

No

Specifies the notification send port(s) in the format B#C#. Use a space to separate multiple ports (B1C1 B1C2).

None

ACK_PORTS

No

Specifies the notification acknowledgment port(s) in the format B#C#. Use a space to separate ports (B1C1 B1C2).

None

TTS_ENGINE

No

Specifies the text-to-speech engine to use.

None

DIALOGIC_AMD

No

The switch to enable answering machine detection. This is a Dialogic feature. If an answering machine is detected, the Dialogic board will not play the message until prompted to do so by the answering machine.

None

VOICE_SIP_LINE_COUNT

Only required if VOICE_PROTOCOL is set to “SIP”.

The number of simultaneous call lines allowed for the SIP client.

20

VOICE_SIP_HOST

Only required if VOICE_PROTOCOL is set to “SIP”.

The name of the host server providing the SIP connection.

None

VOICE_SIP_PORT

Only required if VOICE_PROTOCOL is set to “SIP”.

The port used by the SIP host for SIP connections.

None

VOICE_SIP_HOST_USER

Only required if VOICE_PROTOCOL is set to “SIP”.

The username used to register to the SIP host.

None

VOICE_SIP_HOST_PASSWORD

Only required if VOICE_PROTOCOL is set to “SIP”.

The password for the username used to register to the SIP host.

None

VOICE_SIP_DISPLAY_NAME

No

Depending on how the SIP server is configured, the display name may be made available to recipients for identification (e.g., caller ID) purposes.

None

VOICE_SIP_STUN_HOST

No

The name of the host server providing STUN services for the SIP connection.

None

VOICE_SIP_STUN_PORT

No

The port used by the STUN host for STUN services.

None

VOICE_SIP_PROTOCOL

No

The SIP transport and media transfer protocols used by the SIP host for VoIP communications.

UDP_RTP

COMM_PORT_MSG_PORT

No

Specifies port(s) to be used for com port notifications. Use spaces to separate multiple ports (COM1 COM2 COM3 COM4).

None

COMM_PORT_MSG_SPEED

No

The port speed. This applies to all COM ports specified by COM_PORT_MSG_PORT.

9600

COMM_PORT_MSG_PARITY

No

The parity bit in each character. This applies to all COM ports specified by COM_PORT_MSG_PORT.

0

COMM_PORT_MSG_DATABITS

No

The number of data bits in each character. This applies to all COM ports specified by COM_PORT_MSG_PORT.

8

COMM_PORT_MSG_STOPBITS

No

The stop bits to send at the end of every character. This applies to all COM ports specified by COM_PORT_MSG_PORT.

0

GNS_SNPP_ADDRESS

No

Specifies the TCP/IP or URL for the SNPP server.

None

GNS_SNPP_PORT

No

Specifies the port for the SNPP server. Typically 444.

25

ENABLE_BROADCAST

No

Enables the broadcast message feature for the GNS.

See CygNet Broadcast and CxGns for more information.

FALSE

BROADCAST_REFRESH_RATE

No

Specifies how often clients will check with the GNS for new broadcast messages in seconds. If you have multiple broadcast-enabled GNS services on the same domain, clients will use the shortest refresh rate.

60

REPORT_TO_AUDIT

No

Writes all CygNet Broadcast messages to the Audit Service.

FALSE